Responsive Flipbook Wordpress Plugin Documentation

Folder Structure - top

Responsive Flipbook WordPress Plugin Folder Structure:

• changelog.txt - this file contains all of the changes from the initial release
• responsive-flipbook.zip - contains all the files required for the plugin to run & install
• responsive-flipbook_1.3.3.zip - contains all the files required for the old version of plugin to run & install
• documentation.zip - contains the help files (which you are currently reading)
• psd.zip - this package contains theme mockups in PSD format

---

FAQ - top

Why cannot I create a book?

Please make sure that your server is ready for the Flipbook plugin. The most important things to verify are:

• Memory Limit - please make sure that your server has at least 64M of memory and you have this code in wp-config.php:
  define( 'WP_MEMORY_LIMIT', '64M' );
• max_input_vars - this option defines how many vars can be send to server in a single request. By default, it is set to 1000. In some case, you would need this option to be set up to 2000.

I do not have a Add Book form after clicking 'Create New Book'?

Please fill a ticket with wp-admin details at our support forum. There is a strange issue at some server where first book cannot be created from the panel and we need to do it manually.

How to set a book to look like in preview?

In FLipbook 2.0, we introduced a Predefined Style option which will adjust the book settings for you. Please notice that you need to save settings after changing the style.

How to force a book to be always opened?

Please just select a 'Always Open?' option from Book Settings -> Main.

How can I disable a single button / buttons from display?

Each of the navigation buttons can be disabled by unchecking the checkbox at Book Settings -> Navigation Settings.

How to display navigation arrows together with other buttons?

Please select 'Group with Navbar' option from Book Settings -> Navigation Settings and make sure that Arrows are enabled.

---

Change Log - top

Responsive Flip Book WordPress Plugin
----------------------------------------------------
15/04/2015 - Version 2.0.0
- NEW FEATURE: 4 New PSD Book Mockups
- NEW FEATURE: 11 Predefined Books / UI Styles
- NEW FEATURE: Bookshelf Shortcode
- NEW FEATURE: Popup Shortcode
- NEW FEATURE: All Shortcodes mapped for Visual Composer
- NEW FEATURE: Hard Covers
- NEW FEATURE: Navigation Style Wizard with predefined styles
- NEW FEATURE: Navigation Settings: border, font, size, color, radius, padding, margins and much more
- NEW FEATURE: Text Navigation
- NEW FEATURE: Four Navigation Positions ( bottom, top, aside left, aside right )
- NEW FEATURE: Navigation Compact Mode
- NEW FEATURE: Left & Right Arrow can be grouped with Navbar
- NEW FEATURE: Icon Select for Navigation Buttons
- NEW FEATURE: 1000+ Icons Integrated 
- NEW FEATURE: Automatic Page numeration with display options
- NEW FEATURE: 650+ Google Fonts for Headings / Content / Pagination / Table of Content
- NEW FEATURE: Second Style for Table of Content
- NEW FEATURE: Always Open option, no need to display book cover
- NEW FEATURE: WYSIWYG editor for HTML content
- NEW FEATURE: Two WYSIWYG editors for double pages
- NEW FEATURE: Table of Content generator
- NEW FEATURE: Page Title for Table of Content generator
- NEW FEATURE: Fullscreen background settings: color & opacity
- NEW FEATURE: Page can link to custom hyperlink
- NEW FEATURE: Drag & Drop Sortable for pages
- NEW FEATURE: WPML Support
- NEW FEATURE: Slide Show Speed Setting
- NEW FEATURE: Automatic Book Naming 
- IMPROVED: Page Previews
- IMPROVED: Wordpress 4.1 compatibility
- IMPROVED: Multisite Support
- IMPROVED: Front-end Performance
- IMPROVED: Back-end Performance
- IMPROVED: Options Panel Rewrite 
- IMPROVED: PO Translations
- IMPROVED: Browsers Support
- IMPROVED: Grid Page View
- IMPROVED: Show All Pages Rewrite
- IMPROVED: Zoom Feature
- IMPROVED: Navigation elements sorting, now with drag & drop
- IMPROVED: Import / Export 
- IMPROVED: Batch Images Import
- IMPROVED: New Media Uploader
- IMPROVED: Mobile & Responsive behavior
- IMPROVED: Brand New Documentation 
- FIXED: Slide Show Looping
- FIXED: Zoom Scrolling
- FIXED: Zoom Fading Issue
- FIXED: Zoom Scaling
- FIXED: Show All Pages alignment & display
- FIXED: HTML Book Styling
- FIXED: Background Image Alignment
- FIXED: WP Themes Integration
- FIXED: First Book Creation Issue
- FIXED: Page Order Issue
- FIXED: Color Picker
- FIXED: Removing Books Issue
- FIXED: Page Preview Display
- FIXED: Bulk Upload Display Issue
- FIXED: Display issues in Front-end
- FIXED: Other small issues

24/04/2014 - Version 1.3.3
- Wordpress 3.9 compatibility
- panel improvements

02/09/2013 - Version 1.3.2
- fixed fatal error on some servers.

30/08/2013 - Version 1.3.1
- import/export fixed.

28/08/2013 - Version 1.3
- rewrited parts of Flip Books Panel,
- fixed max_imput_vars issues,
- added page custom CSS,
- added IE8 support,
- added batch image upload,
- added import/export settings,
- added page preview in panel,
- added fullscreen mode,
- added zoom out button,
- minor and major fixes and improvements.

22/04/2013 - Version 1.2.8
- fixed adding new pages.

18/04/2013 - Version 1.2.7
- fixed thumbnails preview,
- fixed links on pages.

6/03/2013 - Version 1.2.6
- zip currepted fixed,
- path fix.

5/03/2013 - Version 1.2.5
- thumbs fix.

4/03/2013 - Version 1.2.4
- IE fix,
- bug fixes.

10/01/2013 - Version 1.2.3
- last page bug fix,
- shadow behavior fixed,
- arrows behavior fixed,
- mobile appearance improved,
- book position fix.

18/12/2012 - Version 1.2.2
- html content columns fix,
- html content fix,
- ESC zoom out fix,
- arrows navigation on zoom added.

12/12/2012 - Version 1.2.1
- WP 3.5 bug fix

7/12/2012 - Version 1.2
- admin panel fixes,
- zoom bug fix,
- next arrow bug fix,
- many minor bug fixes.

21/11/2012 - Version 1.1.1
- admin panel bug fix

9/11/2012 - Version 1.1
- zoom upgrade,
- admin panel bug fix,
- responsive fix,
- auto deleting books fix, 
- minor bug fixes,
- admin panel functionality improvements,
- admin panel design improvements.

18/05/2012 - Version 1.0
- release

---

Sources and Credits - top

We've used the following libraries:

• turn.js v.3
• jQuery DoubleTap
• Select2
• TinyMce
• Ace Editor

Preparing WordPress - top

If you already have WordPress installed on your server just skip to the next section. If you haven't yet installed WordPress on your server here you will find a complete guide on this topic. Just follow the steps and you will be ready in a blink of an eye with your shiny new WordPress website.

---

Installation and Plugin Activation - top

Each WordPress plugin can be installed in two ways: via ftp client or through the admin panel:

Installing WordPress Plugin via FTP client:

• unzip the 'responsive-flipbook.zip' package (the zip package is inside the folder you have downloaded from CodeCanyon),
• connect to your server,
• navigate to the folder where your WordPress is installed,
• upload the 'responsive-flipbook' folder into the 'wp-content/plugins' directory (the path will look like this: wp-content/plugins/responsive-flipbook),
• open the wp-admin panel (navigate through web browser to the folder where you have installed the WordPress e.g www.your_domain.com/wp-admin/),
• login to your wp-admin panel then from the sidebar on the left choose 'Plugins',
• find the 'Responsive Flipbook Wordpress Plugin' and click the 'Activate' button next to it.

Installing Plugin via WordPress Admin Panel:

• open the wp-admin panel (navigate through web browser to the folder where you have installed the WordPress e.g www.your_domain.com/wp-admin/),
• login to your wp-admin panel then from the sidebar on the left choose 'Plugins',
• under 'Plugins' choose 'Add New' then 'Upload',
• you will be redirected to upload form, click the 'choose file' button and navigate to the unzipped package that you have download from CodeCanyon site, inside that package is a file called 'responsive-flipbook.zip' choose it and click 'open',
• once the plugin is done uploading it will automatically install,
• after the installation you will be able to activate the plugin, to do this click the "blue" activation link.

---

How to set up your book to look like in CodeCanyon preview - top

If you want to set up your book to look like the Flipbook preview from CodeCanyon please follow this guide.

• Once you install the plugin please go to Flipbooks, and create a new book.
• You will notice a Predefined Book Style dropdown with 11 different styles from preview.
• To import style, please select one of them to begin the process.

Please notice that you need to save book settings to see changes in Front-end. You can also change each of the settings and adjust them to your needs.

---

How To Update Flipbook from version < 1.x important! - top

First of all, please understand that we have changed a lot of things in the Options panel. To be sure, that all your settings and books are safe during and after the update, please download the backup file from the notification box at 'Flipbooks'. Additionaly, we will also create a backup in the database.

After a download of Backup file, please follow the steps from the section below ( How To Update Flipbook from version 2.0+ ) and after it is done please save settings for each of your book separately. In some cases, you will need to adjust the settings to achieve the same UI style like before.

How To Update Flipbook from version 2.0+ - top

The update should look like this first go to the Envato Toolkit, there you will find two fileds that you must fill out first is the username (this is the username that you used to purchase at CodeCanyon) the second is the API key, to get your API key login to your CodeCanyon account and go to Settings > API Key. Generate your API key and paste it inside the admin panel.

You will see Responsive Flipbook Wordpress Plugin displayed bellow when you click the save settings. When update is available you will see it bellow those two fields all you need to do is click Install Automatically button. See the image bellow:

Bookshelf - top

In the first tab you will find all of the books. From here you can:

• Create New Book - allows you yo create a new book.

When there is atleast one book added, you can control the options and pages by clicking on the buttons near to the book cover.

• Edit Settings - will forward you to Book Settings page.
• View Pages - will forward you to Book pages section.
• Delete Book - will delete the book and all pages

---

Book Settings - top

Main

• Book Name - Flip book name is used to generate a unique shortcode for the book (NOTE: Please use only laters, numbers and spaces), width and height are used to specify books dimantions.
• Page Width / Page Height - Specify the single page size in the book.
• Always Open - Select this option to prevent the book from closing.

Decorations

• Border Size / Border Color / Border Radius - Set up books border, it's color and radius.
• Book Outline / Outline Color - Set up books outline - line displayed outside the border.
• Inner Page Shadow - Enable/Disable book inner shadow.
• Edge Page Outline / Outline Color - Enable/Disable page edge outline - it is used to create 3D like feeling. If you don't have border around your book we suggest disabling this feature.
• Fullscreen Overlay / Opacity - Specify the fullscreen overlay opacity and color.
• New Table Of Content Style - Enable this option to use new Table of Content style.

Fonts Settings

• Heading Font - Specify the font size, font family, font style, line height and color for Headings.
• Content Font - Specify the font size, font family, font style, line height and color for Content.
• Pagination Font - Specify the font size, font family, font style, line height and color for Pagination.
• Table Of Contents Font - Specify the font size, font family, font style, line height, color and hover color for Table of Content.

Zoom

• Border Size / Border Color / Border Radius - Specify parameters for the border that is displayed around the zoomed page.
• Outline / Outline Color - Enable/Disable zoom panel outline, specify it's color.

Show All Pages Settings

• Thumbnail Columns - Show all pages panel contains thumbnails of each page, here you can specify number of columns of those thumbnails.
• Thumbnail Border Size / Border Color - Border Size - displayed around all thumbnails.
• Vertical Padding / Horizontal Padding - Specify thumbnails vertical and horizontal padding.
• Border Size / Border Color / Border Radius - Specify parameters for the show all pages panel border. This border is displayed around all of the thumbnails.
• Panel Outline / Outline Color - Specify show all pages panel outline - outline is a 1px line displayed around the border.

Navigation Settings

Notice: Please notice that you can change the order of buttons by clicking and dragging the icon near to tooltip.

• Compact Mode / Menu Alignment / Stack Buttons / Text Buttons - Enable Compact mode to display navigation sticking to book. / Enable Stack buttons if you want to display the radius border only on first and last buttons. / Choose the position of the menu from Menu Alignment options. / Enable Text buttons to display predefined text instead of icons.
• Table Of Contents / Page Index / Icon - Enable/Disable Table of Contents button and select the icon.
• Zoom / Zoom Icon / Zoom Out Icon - Enable/Disable Zoom button and select the icon.
• Slide Show / Play Icon / Stop Icon - Enable/Disable Slide Show button and select the icon.
• Show All Pages / Icon / Close Icon - Enable/Disable Show All Pages button and select the icon.
• Fullscreen / Icon / Close Icon - Enable/Disable Fullscreen button and select the icon.
• Arrows / Group With Navbar / Prev Icon / Next Icon - Enable/Disable Arrows buttons and select the icon.

Navigation Style

• Enable General Style - Specify the general style (padding, margin, font size, bottom border) nav button.
• Default Style / Color / Background - Specify the color, background color, font size, buttons border radius for default (unactive) button.
• Hover Style / Color / Background - Specify the color, background color, font size, buttons border radius for button hover.
• Default Border Style / Color / Radius - Enable border styles for buttons.
• Hover Border Style / Color / Radius - Enable border styles for hover buttons.

Pagination Settings

• Enable Pagination Display / Hide On First & Last Page - Select this option to enable automatic pagination display.
• Style / Background - Specify background color.
• Border / Color / Size / Radius - Enable border styles for pagination.
• Vertical Position / Horizontal Position - Select Vertical & Horizontal position for pagination.
• Vertical Padding / Horizontal Padding - Specify pagination Vertical & Horizontal padding.
• Vertical Margin / Horizontal Margin - Specify pagination Vertical & Horizontal margin.

Hard Covers

• Enable Hard Cover - Select this option to enable hard covers.
• Front Cover Side - Specify color for Front Cover Side.
• Back Cover Side - Specify color for Back Cover Side.

Notice: If you want to use your own custom fonts, not listed in our settings page, you need to add them manually.

Notice: Before leaving the this tab make sure to click the 'Save Options' button at the bottom or top of the panel, otherwise your changes will be lost.

Pages Settings - top

• Page Type - Select page type: single - normal single page (left or right), double - one image displayed across both pages (left and right).
• Page Title - Specify page title used in Table of Contents.
• Page Index - Specify page index (better leave default value).
• Page URL - Specify the page URL. After that the whole page would work as a link to specified URL (leave empty to disable).
• Page Custom Class - Specify page custom class (NOTE: Use it in the Page CSS field to target current page).
• Left Page Content - Here you can specify the HTML content which will be displayed on the page or left page (double page). To easily place content in two columns (for left and right pages) use the button alongside.
• Page CSS - Here you can specify the CSS which will be applied to the page.

Tools and Import & Export - top

As you can see at the image above, you have a few options here:

• Import - use this field to import all Flipbooks and pages settings from previously created backup. (NOTE: File must have .rfb extension).
• Export - Use this field to export all Flipbooks and pages settings to a file. (NOTE: This exports only settings. To export used images you will have to use other plugin).
• Batch Images Upload - use this feature to import multiple images at once. Please notice that the order and amount of Normal and Large images must be exactly the same. If you do not wish to use zoomed (large) images you can left this field empty.